Expand description
§Cucumber testing framework for Rust
An implementation of the Cucumber testing framework for Rust. Fully native, no external test runners or dependencies.
§Usage
Describe testing scenarios in .feature
files:
Feature: Eating too much cucumbers may not be good for you
Scenario: Eating a few isn't a problem
Given Alice is hungry
When she eats 3 cucumbers
Then she is full
Implement World
trait and describe steps:
use std::time::Duration;
use cucumber::{given, then, when, World as _};
use tokio::time::sleep;
#[derive(cucumber::World, Debug, Default)]
struct World {
user: Option<String>,
capacity: usize,
}
#[given(expr = "{word} is hungry")] // Cucumber Expression
async fn someone_is_hungry(w: &mut World, user: String) {
sleep(Duration::from_secs(2)).await;
w.user = Some(user);
}
#[when(regex = r"^(?:he|she|they) eats? (\d+) cucumbers?$")]
async fn eat_cucumbers(w: &mut World, count: usize) {
sleep(Duration::from_secs(2)).await;
w.capacity += count;
assert!(w.capacity < 4, "{} exploded!", w.user.as_ref().unwrap());
}
#[then("she is full")]
async fn is_full(w: &mut World) {
sleep(Duration::from_secs(2)).await;
assert_eq!(w.capacity, 3, "{} isn't full!", w.user.as_ref().unwrap());
}
#[tokio::main]
async fn main() {
World::run("tests/features/readme").await;
}
Add test to Cargo.toml
:
[[test]]
name = "readme"
harness = false # allows Cucumber to print output instead of libtest
For more examples check out the Book (current | edge).
§Cargo features
macros
(default): Enables step attributes and auto-wiring.timestamps
: Enables timestamps collecting for all Cucumber events.output-json
(impliestimestamps
): Enables support for outputting in Cucumber JSON format.output-junit
(impliestimestamps
): Enables support for outputting JUnit XML report.libtest
(impliestimestamps
): Enables compatibility with Rustlibtest
’s JSON output format. Useful for IntelliJ Rust plugin integration.tracing
: Enables integration withtracing
crate.
§Supporting crates
The full gamut of Cucumber’s Gherkin language is implemented by the gherkin
crate. Most features of the Gherkin language are parsed already and accessible via the relevant structs.
§Known issues
Scenario Outline
is treated the same asOutline
orExample
in the parser (gherkin/#19).
§License
This project is licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Re-exports§
pub use gherkin;
Modules§
- Tools for composing CLI options.
- codegen
macros
Helper type-level glue forcucumber_codegen
crate. - Key occurrences in a lifecycle of Cucumber execution.
gherkin::Feature
extension.- Tools for parsing Gherkin files.
- Tools for executing
Step
s. - Extension of a
TagOperation
. - tracing
tracing
tracing
integration layer. - Tools for outputting
Cucumber
events.
Structs§
- Top-level Cucumber executor.
- Arbitrary event, optionally paired with additional metadata.
Enums§
- Type determining whether
Scenario
s should run concurrently or sequentially.
Traits§
- Parameter
macros
Custom parameter of a Cucumber Expression. - Source of parsed
Feature
s. - Writer of
Cucumber
events to some output. - Extension of
Writer
allowing its normalization and summarization.
Type Aliases§
- Alias for a
gherkin::Step
function that returns aLocalBoxFuture
.
Attribute Macros§
- given
macros
Attribute to auto-wire the test to theWorld
implementer. - then
macros
Attribute to auto-wire the test to theWorld
implementer. - when
macros
Attribute to auto-wire the test to theWorld
implementer.
Derive Macros§
- Parameter
macros
In addition to default parameters of Cucumber Expressions, you may implement and use custom ones. - World
macros
Derive macro for implementing aWorld
trait.